/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.tool.axili.command;

import axil.tool.axili.Axili;


/**
 * An object representing a command for the Axil interpreter.
 */
public abstract class Command implements Comparable<Command> {
	private String keyword;
	private String shortcut;
	private String description;
	private String[] args;


	protected Command(String keyword, String shortcut, String description,
	                  String... args) {
		this.keyword = keyword;
		this.shortcut = shortcut;
		this.description = description;
		this.args = args;
	}


	public String keyword()		{
		return keyword;
	}
	public String shortcut()	{
		return shortcut;
	}
	public int args() 			{
		return args.length;
	}
	public String description()	{
		return description;
	}


	public String summary() {
		StringBuilder b = new StringBuilder(keyword);
		for (String arg : args) {
			b.append(" <");
			b.append(arg);
			b.append('>');
		}
		return b.toString();
	}


	/**
	 * Compares this object with the specified object for order.  Returns a
	 * negative integer, zero, or a positive integer as this object is less
	 * than, equal to, or greater than the specified object.
	 */
	public int compareTo(Command cmd) {
		return keyword.compareTo(cmd.keyword);
	}


	/**
	 * Execute this command with the given arguments. The argument count exactly
	 * matches the requirements for this command.
	 */
	public abstract void execute(Axili tool, String[] args);
}
